This endpoint returns structured Assignment objects. As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results array and will be indexed by ID in the assignments top-level JSON key. Please see our Response Format section for more information.
Any of the below associations can be included in your request by providing the include param, e.g. include=association1,association2.
assignee(User) - Retrieves the user assigned to the task. The response will includeassignee_id, which references the data in theuserstop-level key.external_references(ExternalReference) - Includes references to external integrations for this object.story(Story) - Retrieves the task. The response will includestory_id, which references the data in thestoriestop-level key.story_allocation_days(StoryAllocationDay) - Retrieves the Story Allocation Days (i.e. Daily Scheduled Hours) for the resource assigned to the task. When using this value, theplannablefilter must be set totrue. To retrieve story allocation days for unnamed resources, also set theinclude_unnamedfilter totrue. The response will includestory_allocation_day_ids, which references the data in thestory_allocation_daystop-level key.
- https://api.mavenlink.com/api/v1https://api.mavenlink.com/api/v1/assignments
{ "assignment": { "story_id": 0, "assignee_id": 0, "resource_id": 0, "current": true, "estimated_minutes": 0, "external_reference": { "service_name": "string", "service_model": "string", "service_model_ref": "string", "external_message": "string", "external_link": "string", "external_status": "string", "locked": true } } }
Response
{ "count": 0, "meta": { "count": 0, "page_count": 0, "page_number": 0, "page_size": 0 }, "results": [ { "key": "string", "id": "string" } ], "assignments": { "property1": { "allocated_minutes": 0, "assignee_id": "string", "created_at": "2019-08-24T14:15:22Z", "current": true, "estimated_minutes": 0, "external_reference_ids": [ "string" ], "resource_id": 0, "story_allocation_day_ids": [ "string" ], "story_id": "string", "updated_at": "2019-08-24T14:15:22Z" }, "property2": { "allocated_minutes": 0, "assignee_id": "string", "created_at": "2019-08-24T14:15:22Z", "current": true, "estimated_minutes": 0, "external_reference_ids": [ "string" ], "resource_id": 0, "story_allocation_day_ids": [ "string" ], "story_id": "string", "updated_at": "2019-08-24T14:15:22Z" } }, "external_references": { "property1": { "created_at": "2019-08-24T14:15:22Z", "external_link": "string", "external_message": "string", "external_status": "string", "last_synced_at": "2019-08-24T14:15:22Z", "locked": true, "service_model": "string", "service_model_ref": "string", "service_name": "string", "status": "string", "subject_id": 0, "subject_ref": { "key": "string", "id": "string" }, "subject_type": "string", "updated_at": "2019-08-24T14:15:22Z" }, "property2": { "created_at": "2019-08-24T14:15:22Z", "external_link": "string", "external_message": "string", "external_status": "string", "last_synced_at": "2019-08-24T14:15:22Z", "locked": true, "service_model": "string", "service_model_ref": "string", "service_name": "string", "status": "string", "subject_id": 0, "subject_ref": { "key": "string", "id": "string" }, "subject_type": "string", "updated_at": "2019-08-24T14:15:22Z" } }, "stories": { "property1": { "ancestor_ids": [ "string" ], "ancestry_depth": 0, "archived": true, "archived_editable": true, "assigned_role_id": "string", "assignee_ids": [ "string" ], "assignment_timestamped_at": "2019-08-24T14:15:22Z", "attachment_ids": [ "string" ], "billable": true, "budget_estimate_in_cents": 0, "budget_used_in_cents": 0, "can_align_time": true, "can_edit": true, "can_post": true, "created_at": "2019-08-24T14:15:22Z", "creator_id": "string", "current_assignment_ids": [ "string" ], "custom_field_value_ids": [ "string" ], "custom_task_status_id": 0, "deleted_at": "2019-08-24T14:15:22Z", "descendant_ids": [ "string" ], "description": "string", "due_date": "2019-08-24", "external_reference_ids": [ "string" ], "fixed_fee": true, "follower_ids": [ "string" ], "formatted_description": "string", "google_document_ids": [ "string" ], "has_out_of_bounds_sads": true, "invoiced_balance_in_cents": 0, "is_time_trackable_type": true, "logged_billable_time_in_minutes": 0, "logged_nonbillable_time_in_minutes": 0, "parent_id": "string", "parsed_description": "string", "percentage_complete": 0, "position": 0, "potential_workspace_resource_ids": [ "string" ], "potential_workspace_resources_with_unnamed_ids": [ "string" ], "priority": 0, "project_plan": true, "read_only": true, "render_description_markdown": true, "reply_ids": [ "string" ], "root_id": "string", "source_dependency_ids": [ "string" ], "start_date": "2019-08-24", "state": "string", "status": "string", "story_state_change_ids": [ "string" ], "story_task_ids": [ "string" ], "story_type": "string", "sub_stories_billable_time_in_minutes": 0, "sub_stories_budget_estimate_in_cents": 0, "sub_stories_budget_used_in_cents": 0, "sub_stories_time_estimate_in_minutes": 0, "sub_story_count": 0, "sub_story_ids": [ "string" ], "subtree_depth": 0, "tag_ids": [ "string" ], "target_dependency_ids": [ "string" ], "time_estimate_in_minutes": 0, "time_trackable": true, "title": "string", "uninvoiced_balance_in_cents": 0, "updated_at": "2019-08-24T14:15:22Z", "weight": 0, "workspace_id": "string", "workspace_resource_ids": [ "string" ], "workspace_resources_with_unnamed_ids": [ "string" ] }, "property2": { "ancestor_ids": [ "string" ], "ancestry_depth": 0, "archived": true, "archived_editable": true, "assigned_role_id": "string", "assignee_ids": [ "string" ], "assignment_timestamped_at": "2019-08-24T14:15:22Z", "attachment_ids": [ "string" ], "billable": true, "budget_estimate_in_cents": 0, "budget_used_in_cents": 0, "can_align_time": true, "can_edit": true, "can_post": true, "created_at": "2019-08-24T14:15:22Z", "creator_id": "string", "current_assignment_ids": [ "string" ], "custom_field_value_ids": [ "string" ], "custom_task_status_id": 0, "deleted_at": "2019-08-24T14:15:22Z", "descendant_ids": [ "string" ], "description": "string", "due_date": "2019-08-24", "external_reference_ids": [ "string" ], "fixed_fee": true, "follower_ids": [ "string" ], "formatted_description": "string", "google_document_ids": [ "string" ], "has_out_of_bounds_sads": true, "invoiced_balance_in_cents": 0, "is_time_trackable_type": true, "logged_billable_time_in_minutes": 0, "logged_nonbillable_time_in_minutes": 0, "parent_id": "string", "parsed_description": "string", "percentage_complete": 0, "position": 0, "potential_workspace_resource_ids": [ "string" ], "potential_workspace_resources_with_unnamed_ids": [ "string" ], "priority": 0, "project_plan": true, "read_only": true, "render_description_markdown": true, "reply_ids": [ "string" ], "root_id": "string", "source_dependency_ids": [ "string" ], "start_date": "2019-08-24", "state": "string", "status": "string", "story_state_change_ids": [ "string" ], "story_task_ids": [ "string" ], "story_type": "string", "sub_stories_billable_time_in_minutes": 0, "sub_stories_budget_estimate_in_cents": 0, "sub_stories_budget_used_in_cents": 0, "sub_stories_time_estimate_in_minutes": 0, "sub_story_count": 0, "sub_story_ids": [ "string" ], "subtree_depth": 0, "tag_ids": [ "string" ], "target_dependency_ids": [ "string" ], "time_estimate_in_minutes": 0, "time_trackable": true, "title": "string", "uninvoiced_balance_in_cents": 0, "updated_at": "2019-08-24T14:15:22Z", "weight": 0, "workspace_id": "string", "workspace_resource_ids": [ "string" ], "workspace_resources_with_unnamed_ids": [ "string" ] } }, "users": { "property1": { "abbreviated_timezone": "string", "account_membership_id": "string", "bio": "string", "city": "string", "classification": "string", "country": "string", "custom_field_value_ids": [ "string" ], "email_address": "string", "external_reference_ids": [ "string" ], "full_name": "string", "headline": "string", "last_site_activity": "2019-08-24T14:15:22Z", "manager_id": "string", "photo_path": "string", "role_id": "string", "skill_ids": [ "string" ], "skill_membership_ids": [ "string" ], "state": "string", "website": "string", "work_sample_ids": [ "string" ] }, "property2": { "abbreviated_timezone": "string", "account_membership_id": "string", "bio": "string", "city": "string", "classification": "string", "country": "string", "custom_field_value_ids": [ "string" ], "email_address": "string", "external_reference_ids": [ "string" ], "full_name": "string", "headline": "string", "last_site_activity": "2019-08-24T14:15:22Z", "manager_id": "string", "photo_path": "string", "role_id": "string", "skill_ids": [ "string" ], "skill_membership_ids": [ "string" ], "state": "string", "website": "string", "work_sample_ids": [ "string" ] } }, "story_allocation_days": { "property1": { "assignment_id": "string", "created_at": "2019-08-24T14:15:22Z", "current": true, "date": "2019-08-24", "external_reference_ids": [ "string" ], "minutes": 0, "story_id": "string", "updated_at": "2019-08-24T14:15:22Z", "workspace_id": "string" }, "property2": { "assignment_id": "string", "created_at": "2019-08-24T14:15:22Z", "current": true, "date": "2019-08-24", "external_reference_ids": [ "string" ], "minutes": 0, "story_id": "string", "updated_at": "2019-08-24T14:15:22Z", "workspace_id": "string" } } }